Arrow Resilience Kit/[root]/Cache

Cache

class Cache<T>

JS/TS-friendly facade over com.sorinirmies.arrow.resiliencekit.Cache, specialized to string keys (the common case for JS/TS caches) to keep this facade's generics simple.

import { Cache } from "arrow-resilience-kit";

const cache = await Cache.create<User>({ maxSize: 1000, ttlMillis: 300_000 });
const user = await cache.getOrPut("user-123", () => userService.fetch("user-123"));

Types

object Companion

Functions

fun clear(): Promise<Unit>

Removes every entry.

fun containsKey(key: String): Promise<Boolean>

Whether key is currently present (and not expired).

fun get(key: String): Promise<T?>

Gets the value for key, or undefined if absent/expired.

fun getOrPut(key: String, loader: () -> Promise<T>): Promise<T>

Gets the value for key, computing and storing it via loader if absent/expired.

fun put(key: String, value: T): Promise<Unit>

Puts value under key.

fun remove(key: String): Promise<T?>

Removes and returns the value for key, or undefined if it wasn't present.

resetStatistics

fun resetStatistics(): Promise<Unit>

Resets statistics counters (not the cache's contents).

fun size(): Promise<Int>

Current number of entries.

fun statistics(): Promise<CacheStatistics>

Current statistics snapshot.